home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Diamond Collection / The Diamond Collection (Software Vault)(Digital Impact).ISO / cdr39 / diet0b26.zip / DIET.DOC next >
Text File  |  1995-02-21  |  22KB  |  486 lines
  1. ===<SOT>=======================================================================
  2.  
  3. ABSTRACT:               Documentation for DIET
  4.                         Copyright (C)1994-1995 C B Dunne
  5. AUTHOR:                 C B Dunne
  6. ORIGINATION:            21-Dec-1994
  7. DATE:                   21-Feb-1995
  8.  
  9. PROGRAM VERSION:        Beta 0.26
  10. PROGRAM DATE:           21-Feb-1995
  11. EXPIRY DATE:            31-Mar-1995
  12.  
  13. ===<NOTE>======================================================================
  14.  
  15. This documentation describes the beta release of DIET.  You are required to
  16. read the section LICENSE AGREEMENT and agree to its terms before using DIET.
  17.  
  18. ===<DESCRIPTION>===============================================================
  19.  
  20. DIET resolves cross-references in the NetScape cache, so that NetScape can be
  21. used to browse the files locally.  Cross-references will be read directly from
  22. the cache;  NetScape will not attempt to go on-line to check for updates.
  23.  
  24. DIET also has an option to rename NetScape's ".MOZ" files in accordance with
  25. the file type and accepted MS-DOS/Windows practice, i.e. ".TXT" for text files,
  26. ".JPG" for JPEG files etc.  Note that this option is enabled in the beta
  27. release for the purpose of testing.  It will be disabled in the shareware
  28. release and enabled in the registered version.
  29.  
  30. ===<PROGRAM REQUIREMENTS>======================================================
  31.  
  32. The program requires:
  33.  ■ A 386 or better processor;
  34.  ■ MS-DOS version 3.10 or later;
  35.  ■ At least 64K of available DOS conventional memory.
  36.  
  37. Recommended:
  38.  ■ A fast hard disk;
  39.  ■ At least 128K of available DOS conventional memory.
  40.  
  41. ===<USAGE>=====================================================================
  42.  
  43. To prepare DIET for use:
  44. ■ Copy all the distribution files into your NetScape directory.
  45. ■ Create a new directory for the cached files you wish to process, e.g.
  46.         C:\NETSCAPE\LOCAL
  47. ■ Edit the file 'DIET.INI' so that the item 'Cache Dir' in section '[DIET]'
  48.   points to the directory thus created (you will only have to do this once).
  49. ■ Add DIET to the NetScape program group under Windows (if desired).
  50.  
  51. To run DIET:
  52. ■ Copy the entire NetScape cache into the directory created above.
  53. ■ Run DIET from the MS-DOS command line (any parameters will be ignored), or
  54.   from a MS-DOS prompt box under Windows.  Alternatively, click on the DIET
  55.   icon under Windows.
  56.  
  57. WARNING:
  58. DIET can be run on the files in situ in the NetScape cache.  However, this will
  59. cause NetScape to get terminally confused, and it may delete the files on exit.
  60. Always run DIET on a copy of the cache, not the cache itself.
  61.  
  62. ===<CONFIGURATION>=============================================================
  63.  
  64. All configuration is done via the DIET.INI file.  This is a standard Windows
  65. style initialization file with three sections:  [DIET], [Links] and [Types].
  66. (Note that most of the configurability is intended as a safeguard against minor
  67. revisions to NetScape or new releases of the HTML spec, and would not normally
  68. be modified.)
  69.  
  70. The [DIET] section configures DIET and has the following entries:
  71.  
  72.         Cache Dir               Specifies the path to the cache (i.e. names the
  73.                                 directory containing FAT), overriding the value
  74.                                 in NETSCAPE.INI if present.
  75.  
  76.                                 The default value is blank, i.e. use the value
  77.                                 in NETSCAPE.INI.
  78.  
  79.         Truncate Name At        Specifies up to 4 characters which, if found in
  80.                                 a remote name in the FAT file, will cause the
  81.                                 name to be truncated at the earliest such
  82.                                 character.
  83.  
  84.                                 The default value is blank, i.e. do not
  85.                                 truncate.  Do not modify.
  86.  
  87.         Skip Name After         Specifies up to 4 skip characters.  The remote
  88.                                 name in a link is matched against file names in
  89.                                 FAT up to and not including the first skip
  90.                                 character.  (The skip character and subsequent
  91.                                 characters are appended to the transformed name
  92.                                 after substitution.)
  93.  
  94.                                 The default value is '#', specifying anchor
  95.                                 points.  Do not modify.
  96.  
  97.         Time Stamp              If 'DIET', DIET changes the time stamp entry
  98.                                 in the FAT for each modified file to reflect
  99.                                 the file's actual time stamp;  if 'NetScape',
  100.                                 DIET stamps the file with the time stamp taken
  101.                                 from the NetScape FAT;  otherwise, the FAT time
  102.                                 stamp is left unchanged and the file time stamp
  103.                                 reflects the (DIET) modification time.
  104.  
  105.                                 The default value is 'None'.
  106.  
  107.         Backup Files            If 'Yes', DIET renames the original FAT file
  108.                                 and each cached file to a ".BAK" file;  if
  109.                                 'No', DIET deletes the original FAT and ".MOZ"
  110.                                 files after processing.
  111.  
  112.                                 The default value is 'No'.
  113.  
  114.         Rename Files            If 'Yes', DIET changes the filename extension
  115.                                 of *all* files (not just text files) to the
  116.                                 appropriate extension for the type of file
  117.                                 (e.g. ".HTM", ".GIF" or ".JPG"), modifying FAT
  118.                                 as required;  if 'No', filename extensions are
  119.                                 left unchanged.
  120.  
  121.                                 The default value is 'No'.  See warning.
  122.                                 (This option is not supported by the shareware
  123.                                 version.)
  124.  
  125.         Full Local Paths        If 'Yes', DIET replaces each local name with
  126.                                 the full pathname of the cached file;  if 'No',
  127.                                 only the filename part of the cached file is
  128.                                 used.
  129.  
  130.                                 The default value is 'No'.  Do not modify.
  131.  
  132.         Full Remote Paths       If 'Yes', DIET replaces each remote name with
  133.                                 the full pathname of the remote file;  if 'No',
  134.                                 remote filenames are not modified.
  135.  
  136.                                 The default value is 'Yes'.  Do not modify.
  137.  
  138.         Verbose                 If 'Yes', DIET displays each file as it is
  139.                                 processed;  if 'No', DIET proceeds silently.
  140.  
  141.                                 The default value is 'Yes'.
  142.  
  143. The [Links] section contains up to 16 entries.  Each entry specifies a link
  144. name (i.e. the search string for cached filename substitution).  The entry
  145. names are ignored but must differ, and the simplest convention is to make the
  146. entry name the same as the link name.
  147.  
  148. The maximum length of a link name is 15 characters.  The default values are:
  149.         HREF = HREF
  150.         SRC =  SRC
  151.  
  152. Entries in this section should not be modified.
  153.  
  154. The [Types] section contains up to 64 entries.  Each entry specifies a type of
  155. file (e.g. an image or text file) and the MS-DOS filename extension associated
  156. with that type of file.
  157.  
  158. The maximum length of a type name is 31 characters, and the maximum length of a
  159. type extension is 3 characters.  The period should not be included in the
  160. extension.  Spaces are ignored.  The default values are:
  161.         fif = applications/fractals
  162.         hqx = application/mac-binhex40
  163.         sit = application/x-stuffit
  164.         exe = application/octet-stream
  165.         ps  = application/postscript
  166.         rtf = application/rtf
  167.         csh = application/x-csh
  168.         ltx = application/x-latex
  169.         sh  = application/x-sh
  170.         man = application/x-troff-man
  171.         zip = application/x-compressed
  172.         tar = application/x-tar
  173.         au  = audio/basic
  174.         aif = audio/x-aiff
  175.         wav = audio/x-wav
  176.         gif = image/gif
  177.         jpg = image/jpeg
  178.         tif = image/tiff
  179.         ras = image/x-cmu-raster
  180.         pnm = image/x-portable-anymap
  181.         pbm = image/x-portable-bitmap
  182.         pgm = image/x-portable-graymap
  183.         ppm = image/x-portable-pixmap
  184.         rgb = image/x-rgb
  185.         xbm = image/x-xbitmap
  186.         xpm = image/x-xpixmap
  187.         htm = text/html
  188.         txt = text/plain
  189.         rtx = text/richtext
  190.         mpg = video/mpeg
  191.         qt  = video/quicktime
  192.         avi = video/x-msvideo
  193.         mov = video/x-sgi-movie
  194.  
  195. Entries in this section should not be modified.
  196.  
  197. NOTES:
  198.  
  199.   ■ Default values are used when the section or entry name(s) in the DIET.INI
  200.     file is/are missing or incorrect.
  201.  
  202.   ■ If the file DIET.INI is not found, DIET will create one with all defaults.
  203.  
  204.   ■ Entry names should not contain semicolons, colons, equal signs or square
  205.     brackets.  This is particularly important for type names.
  206.  
  207. WARNING:
  208.  
  209.   ■ NetScape deletes on exit any cached file not having the extension ".MOZ".
  210.     You should avoid using the "Rename Files" option within the cache
  211.     directory.  Before enabling this option, copy the entire cache to another
  212.     directory, remembering to also modify the item "Cache Dir" to reflect the
  213.     change.
  214.  
  215. ===<THE MO>====================================================================
  216.  
  217. When DIET is run, it first configures itself according to the INI file.  It
  218. then uses the NETSCAPE.INI file to find the cache directory, and reads the FAT
  219. file therefrom.
  220.  
  221. The FAT file consists of a series of entries of the form:
  222.         <cache time> <local name> <remote name> <type> <length>
  223. (there is some other information also, but this is ignored).  DIET builds a
  224. list of these entries.
  225.  
  226. The list is then traversed.  For each file on the list, DIET checks to see if
  227. it is an HTML file.  If it isn't, the file is left unchanged.  If it is an HTML
  228. file, DIET reads each line and looks for a cross-reference ('link').
  229.  
  230. For each link found, DIET resolves the (remote) pathname, substituting '.' and
  231. '..' etc., to obtain the full remote pathname.  It then checks to see if this
  232. name is on the list.
  233.  
  234. If the name is not on the list, then the file is not cached.  In this case,
  235. the name is left unchanged, unless "Full Remote Paths" is 'Yes' in the DIET.INI
  236. file, when the full remote pathname is substituted.
  237.  
  238. If the name is on the list, then the file is cached.  In this case, DIET
  239. replaces the name with the corresponding local name from the list:  either the
  240. full pathname or the filename part only is used, according to the value of
  241. "Full Local Paths" in the DIET.INI file.
  242.  
  243. If the original remote name contained a skip character, this and subsequent
  244. characters are appended to the substituted (local) name.
  245.  
  246. After all substitutions have occurred, DIET will either delete or rename the
  247. old file (according to the value of "Backup Files" in the DIET.INI file) and
  248. replace it with the new file.
  249.  
  250. Finally, after all files have been processed, DIET will rewrite the FAT file
  251. with the (possibly different) file lengths.  If "Rename Files" is 'Yes' in the
  252. DIET.INI file, then DIET will rename each file according to the details in the
  253. [Types] section of the DIET.INI file.  DIET will either delete or rename the
  254. old FAT (according to the value of "Backup Files" in the DIET.INI file).
  255.  
  256. ===<RESTRICTIONS>==============================================================
  257.  
  258. The list of files is built in memory, and this restricts its size.  (Each list
  259. entry requires typically about 128 bytes.)
  260.  
  261. Only HTML files are processed.  These are recognized by having type "text/html"
  262. in the FAT file.  Other files containing file names are not modified;  in
  263. particular, text/plain and GIF89a files may contain file names embedded in the
  264. text, but these are not recognized by DIET and are left unchanged.
  265.  
  266. Links in the FAT file are *not* removed by DIET, on the assumption that you may
  267. in the future access further remote files with links to a local file and
  268. re-DIET these.
  269.  
  270. The beta release (irrespective of the state of "Verbose") produces an
  271. advertisement banner before execution.  See the section BETA RELEASE for more
  272. details.
  273.  
  274. ===<BETA RELEASE>==============================================================
  275.  
  276. The beta release has an expiry date.  Any attempt to use the program after that
  277. date will fail.  After that date, you must stop using this version of DIET and
  278. delete all copies of it in your possession.  The intention is that a new
  279. version of DIET will be distributed as shareware at that time.
  280.  
  281. Any attempt to disable, suppress or modify the opening screen advertisement
  282. banner, the key check or the delay routine, or to modify the program in any
  283. other way, constitutes a breach of the beta release license agreement and
  284. infringes the author's copyright and intellectual property rights.
  285.  
  286. You may use this program in accordance with the terms of the LICENSE AGREEMENT
  287. which you are required to read before using the program, until the expiry date.
  288.  
  289. If you experience any difficulties, locate any bugs or have any suggestions how
  290. DIET might be improved, please contact the distributor at:
  291.  
  292.         Metrotel Multi-Media Ltd.
  293.         Premier House
  294.         2 Gayton Road
  295.         HARROW
  296.         Middlesex
  297.         HA1 2XU
  298.         United Kingdom
  299.  
  300. Or telephone:
  301.         +44 181 863 9001 (outside UK)
  302.            0181 863 9001 (UK only)
  303.  
  304. ===<LICENSE AGREEMENT>=========================================================
  305.  
  306. METROTEL MULTI-MEDIA LTD declares that it does not sell or transfer any rights
  307. in its software but merely grants the right to use its software by means of
  308. this Software License Agreement.  METROTEL MULTI-MEDIA LTD specifically retains
  309. the title to all its computer software.
  310.  
  311. 1     DEFINITIONS
  312.  
  313. 1.1   The licensee is the person, persons or organization using or possessing
  314.       DIET or any part thereof as defined under clause (1.3).
  315.  
  316. 1.2   The licensor is:
  317.           Metrotel Multi-Media Ltd.
  318.           Premier House
  319.           2 Gayton Road
  320.           HARROW
  321.           Middlesex
  322.           HA1 2XU
  323.  
  324.           Tel. 0181-863 9001
  325.  
  326. 1.3   The term DIET refers to this beta release of the machine executable
  327.       program and/or ancillary files and includes all source code, executables,
  328.       data files, libraries, help files, documentation, utilities and other
  329.       software components as shipped, or any part thereof.
  330.  
  331. 1.4   The term instance of DIET refers to DIET as stored, whether physically,
  332.       electronically or otherwise, and whether in machine-readable form,
  333.       human-readable form or otherwise, on paper, floppy disk, hard disk,
  334.       CD-ROM, magnetic tape or other media.
  335.  
  336. 1.5   The term user data refers to any configuration, data, batch, program or
  337.       other file created by the licensee with, or in conjunction with DIET.
  338.  
  339. 2     TERMS
  340.  
  341. 2.1   In any dispute arising as a result of this license, the laws of England
  342.       shall apply.
  343.  
  344. 2.2   This license constitutes a binding legal agreement between the licensee
  345.       and the licensor, and its terms and conditions constitute the entire
  346.       agreement between those parties, superseding all previous agreements,
  347.       representations, understandings and negotiations.
  348.  
  349. 2.3   If any terms or conditions of this license shall be found to be illegal
  350.       or unenforceable then, notwithstanding, this license shall remain in full
  351.       force and effect and such terms or conditions shall be deemed stricken.
  352.  
  353. 2.4   This license may not be amended other than in writing signed by an
  354.       authorized representative of the parties.  No amendment of this license
  355.       shall be effective unless it is in writing and signed by duly authorized
  356.       representatives of both parties.
  357.  
  358. 2.5   No term or condition hereof shall be deemed waived and no breach excused
  359.       unless such waiver or consent shall be in writing and signed by the party
  360.       claimed to have waived or consented.  Any consent by any party to or
  361.       waiver of a breach by the other, whether express or implied, shall not
  362.       constitute a consent to, waiver of or excuse for any other, different or
  363.       subsequent breach.
  364.  
  365. 2.6   This license shall be binding on and shall inure to the benefit of the
  366.       heirs, executors, administrators, successors and assignees of the parties
  367.       hereto, but nothing in this paragraph shall be construed as a consent to
  368.       any assignment of this license by either party except as provided herein.
  369.  
  370. 2.7   If the licensee retains one or more instance(s) of DIET, the licensee is
  371.       deemed to have accepted this license, and all its terms and conditions.
  372.  
  373. 2.8   If the licensee does not wish to accept this license, or upon termination
  374.       hereof, the licensee must immediately destroy or return to the licensor
  375.       any instance of DIET remaining in the possession of the licensee.
  376.  
  377. 2.9   The obligations under clause (2.8) shall survive the termination or
  378.       rescission of this license.
  379.  
  380. 2.10  Upon acceptance of this license, the licensor grants the licensee the
  381.       non-exclusive, non-transferable right to use DIET on any computer in any
  382.       configuration for the purposes of evaluation and trial use only.
  383.  
  384. 2.11  The licensee may freely distribute this beta release to any person,
  385.       computer, company, site or network, in any archive format, provided that:
  386.       1. None of the original files are modified, including this file.
  387.       2. All of the original files are included, including this file.
  388.       3. The release is clearly and prominently described as a beta release for
  389.          the purposes of testing and development only.
  390.       4. The licensee makes no proprietary claim in respect of any file
  391.          distributed as part of DIET.
  392.  
  393. 2.12  The licensee may charge a nominal fee for the distribution of DIET,
  394.       provided that it clearly and prominently stated that payment of such a
  395.       fee is for distribution only and does not constitute consideration in
  396.       respect of this agreement to confer any benefit or right under any term
  397.       or terms hereof.
  398.  
  399. 2.13  The licensee may not decompile, disassemble, modify, patch or in any way
  400.       reverse-engineer any instance of DIET, nor distribute any program or
  401.       procedure performing, or information describing such a process.
  402.  
  403. 2.14  The licensee may otherwise distribute without royalty any user data
  404.       pertaining to any instance of DIET, provided that the licensee
  405.       indemnifies, holds harmless and defends the licensor from and against any
  406.       action arising out of such distribution.
  407.  
  408. 2.15  While the licensor intends to distribute a commercial release of DIET,
  409.       the licensor reserves the right at any time not to release a commercial
  410.       release of DIET or, if released, to alter prices, features,
  411.       specifications, capabilities, functions, licensing terms, release dates,
  412.       general availability or other characteristics of the commercial release.
  413.  
  414. 3     TERMINATION
  415.  
  416. 3.1   This license may be terminated by the licensor if, at any time, the
  417.       licensee:
  418.       1. Fails to comply with any material term or condition thereof, and;
  419.       2. Fails to cure such failure within fifteen days after notices of such
  420.          failure by the licensor.
  421.  
  422. 3.2   This license may be terminated by the licensor if, at any time, the
  423.       licensee's normal business operations are disrupted or discontinued for
  424.       more than thirty days by reason of insolvency, bankruptcy, receivership,
  425.       or business termination.
  426.  
  427. 3.3   The licensee may at any time terminate this license by complying with
  428.       the obligations under clause (2.8).
  429.  
  430. 3.4   This license shall terminate on the stated expiry date.
  431.  
  432. 4     LIMITED WARRANTY
  433.  
  434. 4.1   DIET is provided gratuitously and, accordingly, the licensor shall not be
  435.       liable under any theory or any damages suffered by the licensee.
  436.  
  437. 4.2   The licensor will not support DIET and will not issue updates to DIET.
  438.  
  439. 5     WARRANTY LIMITATIONS AND DISCLAIMERS
  440.  
  441. 5.1   The licensor makes no warranties, either express or implied, with respect
  442.       to the use of DIET, its performance or its fitness for any particular
  443.       use.  DIET is licensed "as is" and in no event will the licensor be
  444.       liable for direct, indirect, incidental or consequential damages
  445.       resulting from use of DIET even if the licensor has been advised of the
  446.       possibility of such damages.
  447.  
  448. 5.2   The licensor disclaims all other warranties, whether express or implied
  449.       (including, but not limited to, implied warranties of merchantability or
  450.       fitness for a particular purpose) to the maximum extent permissible under
  451.       applicable law.
  452.  
  453. 5.3   The licensor disclaims all liability in respect of loss (including but
  454.       not limited to loss of profits, revenue or savings, loss of information,
  455.       interruption of business, or other loss) arising out of the use of, or
  456.       inability to use DIET, to the maximum extent permissible under applicable
  457.       law.
  458.  
  459. ===<INTELLECTUAL PROPERTY RIGHTS>==============================================
  460.  
  461. All source code, executables, data files, libraries, help files, documentation,
  462. utilities and other ancillary components of DIET as shipped are copyright
  463. material.  All rights are reserved by the copyright owner(s):
  464.  
  465. DIET program:
  466. (C)1994-1995 C B Dunne
  467.  
  468. CEXT utility library:
  469. (C)1984-1995 C B Dunne
  470.  
  471. DIET source code:
  472. (C)1994-1995 C B Dunne
  473.  
  474. DIET documentation:
  475. (C)1994-1995 C B Dunne
  476.  
  477. DIET beta icon, DIET shareware icon and DIET icon:
  478. (C)1995 C B Dunne
  479.  
  480. MS Run-Time Library
  481. (C)1992 Microsoft Corp.
  482.  
  483. All trademarks are acknowledged.
  484.  
  485. ===<EOT>=======================================================================
  486.